GET /manage/v2/databases/{id|name}/super-databases
Summary
Retrieve a list of super-databases of which the specified database
is a sub-database. It only includes information about where the database
serves as a sub-database on the current cluster; if you want to find where
it serves as a sub-database on another cluster, you will have to make the
call from the other cluster.
URL Parameters
format
The format of the data in the response body. Allowed values:
html, json or xml (default).
Use this parameter to override the Accept header.
Request Headers
Accept
The desired MIME type of the data in the response body. If the
format parameter is present, it takes precedence over this
header. Supported values: application/xml (default),
application/json, text/html.
Response Headers
Content-type
The MIME type of the data in the response body. Depending upon the
value of the format parameter or Accept header, one of
application/xml, application/json, or
text/html.
Response
Upon success, MarkLogic server returns status code 200 (OK) and the
response body contains the requested data.
Required Privileges
This operation requires the manage-user role, or the
following privilege:
The structure of the output returned from
this REST API is as follows:
meta
Properties of the view rather than the resource.
This is a complex structure with the following children:
uri
The path to the view.
current-time
The timestamp for when the view was generated.
elapsed-time
The time required to construct the view. The
elapsed time indicates the relative cost of generating the view. Consider
the cost when determining how frequently to request a view.
start-min
The timestamp for filtering out more recent
requests or transactions.
view-error
An error limiting the data in the view.
This is a complex structure with the following children:
error-type
The kind of error.
error-name
The name of the error.
error-code
The error identifier.
error-message
The error text.
relations
Relationships to resources.
This is a complex structure with the following children:
relation-group
Related resources with the same type.
This is a complex structure with the following children:
uriref
The path for a resource or list of resources.
typeref
The type of a resource or list of resources.
roleref
A role that distinguishes the resource.
relation-count
The number of related resources.
relation
A specific related resource.
This is a complex structure with the following children:
qualifiers
A list of associated resources that distinguish the resource.
This is a complex structure with the following children:
qualifier
Another resource that qualifies the resource.
This is a complex structure with the following children:
uriref
The path for a resource or list of resources.
typeref
The type of a resource or list of resources.
idref
The numeric identifier for the resource.
nameref
The name of the resource.
uriref
The path for a resource or list of resources.
typeref
The type of a resource or list of resources.
roleref
A role that distinguishes the resource.
idref
The numeric identifier for the resource.
nameref
The name of the resource.
list-items
Items of this resource type.
This is a complex structure with the following children:
list-count
The number of items of this resource type.
list-item
An item of this resource type.
This is a complex structure with the following children:
uriref
The path for a resource or list of resources.
roleref
A role that distinguishes the resource.
idref
The numeric identifier for the resource.
nameref
The name of the resource.
item-summary
A brief summary of the partition.
This is a complex structure with the following children:
forest-count
range
Range configuration for the range assignment policy.
This is a complex structure with the following children:
lower-bound
The lower bound of the range on the forest.
upper-bound
The upper bound of the range on the forest.
related-views
A list of broader or narrower views on the resource or resource type.
This is a complex structure with the following children:
related-view
A broader or narrower view on the resource or resource type.
This is a complex structure with the following children:
view-type
The kind of view.
view-name
The name of the view.
view-uri
The path for the view.
Example
http://localhost:8002/manage/v2/sub-db/super-databases
==> Retrieve a summary of the super-databases of sub-db.
Stack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.
Stack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.